[AppConfig] az appconfig feature filter: Update feature filter help text#31999
[AppConfig] az appconfig feature filter: Update feature filter help text#31999ChristineWanjau wants to merge 1 commit intoAzure:devfrom
az appconfig feature filter: Update feature filter help text#31999Conversation
️✔️AzureCLI-FullTest
|
|
Hi @ChristineWanjau, |
️✔️AzureCLI-BreakingChangeTest
|
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
There was a problem hiding this comment.
Pull Request Overview
This PR fixes the help text examples for Azure CLI AppConfig feature filter commands by correcting the JSON escaping syntax. The changes address user issues with invalid command examples that were causing problems when users tried to execute them.
- Updates filter parameter quoting in help text examples to use proper JSON escaping
- Fixes both
addandupdatecommand examples for feature filters - Corrects the syntax from backslash escaping to proper single quote wrapping for JSON values
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| az appconfig feature filter update -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters Name='\\"Value\\"' Name2='\\"Value2\\"' | ||
| - name: Update the filter at index 2 (zero-based index) for feature 'color' with label MyLabel with name 'MyFilter' and 2 parameters. | ||
| text: | ||
| az appconfig feature filter update -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters Name=\\"Value\\" Name2=\\"Value2\\" --index 2 | ||
| az appconfig feature filter update -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters Name='\\"Value\\"' Name2='\\"Value2\\"' --index 2 |
There was a problem hiding this comment.
The filter-parameters syntax appears incorrect. Multiple parameters should be space-separated, but 'Name2' should be a separate parameter. The current syntax suggests Name2 is part of the first parameter's value.
| az appconfig feature filter update -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters Name='\\"Value\\"' Name2='\\"Value2\\"' | ||
| - name: Update the filter at index 2 (zero-based index) for feature 'color' with label MyLabel with name 'MyFilter' and 2 parameters. | ||
| text: | ||
| az appconfig feature filter update -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters Name=\\"Value\\" Name2=\\"Value2\\" --index 2 | ||
| az appconfig feature filter update -n MyAppConfiguration --feature color --label MyLabel --filter-name MyFilter --filter-parameters Name='\\"Value\\"' Name2='\\"Value2\\"' --index 2 |
There was a problem hiding this comment.
The filter-parameters syntax appears incorrect. Multiple parameters should be space-separated, but 'Name2' should be a separate parameter. The current syntax suggests Name2 is part of the first parameter's value.
Related command
az appconfig feature filter
Description
This PR updates the feature filter help text to have the correct json escaped filter example. Users are running into issues when testing out the examples. Azure/AppConfiguration#1024
Testing Guide
History Notes
[App config]
az appconfig feature filter: Update feature filter help textThis checklist is used to make sure that common guidelines for a pull request are followed.
The PR title and description has followed the guideline in Submitting Pull Requests.
I adhere to the Command Guidelines.
I adhere to the Error Handling Guidelines.